Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add sample site #125

Merged
merged 1 commit into from
Apr 17, 2024
Merged

docs: add sample site #125

merged 1 commit into from
Apr 17, 2024

Conversation

dgarcia360
Copy link
Contributor

@dgarcia360 dgarcia360 commented Apr 9, 2024 •
edited
Loading

Motivation

Adds a sample docs site to the project.

How to test

  1. Make sure you meet the prerequisites.
  2. Clone the PR.
  3. Go to the docs folder: cd docs
  4. Build the docs: make preview
  5. The site should render at http://127.0.0.1:5500/

Next steps after merging

  1. Add content to the site (maintainers)

  2. Request zendesk tag for this project, optional (@annastuchlik)

  3. Configure the subdomain (@dgarcia360)

  4. Configure GitHub Pages (maintainers)

    Could you please enable the following option?

In the repository’s Settings, navigate to the Pages section and select GitHub Actions as the deployment source.

image
Thanks!

@guy9
Copy link
Collaborator

guy9 commented Apr 15, 2024

@annastuchlik please review

@guy9
Copy link
Collaborator

guy9 commented Apr 15, 2024

Even though it's empty, check that it works and we will add content after the merge

@annastuchlik
Copy link

LGTM
@tarzanek @julienrf Please merge this PR and configure GitHub pages (as shown in the description of this PR).

Background:
We want to create and publish documentation for Scylla Migration in the same way as we do for all other Scylla projects. This PR adds the required components, such as the necessary folder structure (docs, source, utils), a Makefile to build the docs with Sphinx, the workflows to build the docs and PRs, a list of dependencies, etc.

Once it's done, we will be able to add content to the docs folder and publish it on https://migrator.docs.scylladb.com.

@tarzanek
Copy link
Contributor

@dgarcia360 what custom subdomain will be needed in Pages?

@tarzanek
Copy link
Contributor

ah, okay, so I read @annastuchlik comment
and subdomain will be
migrator.docs.scylladb.com
I configured it and triggered a build

@tarzanek tarzanek merged commit 5f0082b into scylladb:master Apr 17, 2024
2 checks passed
@tarzanek
Copy link
Contributor

there was one more option that picked workflow, but I assume it will be picked up after merge automagically

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@dgarcia360 @guy9 @annastuchlik @tarzanek